DICE API Documentation/com.embabel.dice.provenance

Package-level declarations

Types

data class ConnectorRef constructor(val connectorId: String, val externalId: String, val display: String? = null) : SourceLocator

A locator that references material owned by an external connector.

ContentAddressedLocator

data class ContentAddressedLocator constructor(val contentHash: String, val display: String? = null) : SourceLocator

A locator that identifies source material by its content hash.

FileLocator

data class FileLocator constructor(val path: String, val display: String? = null) : SourceLocator

A locator that points at a resource by file path.

ProvenanceEntry

data class ProvenanceEntry constructor(val locator: SourceLocator, val chunkId: String? = null, val startOffset: Int? = null, val endOffset: Int? = null, val contentHash: String? = null, val sourceRevision: String? = null)

Links a proposition to the source material it was derived from.

ProvenanceEvidenceKey

object ProvenanceEvidenceKey

The stable string identity of one piece of evidence. Producers encode an entry, hand the string to whoever records the fold, and matches later checks a live entry against it.

SourceIdentityBounds

object SourceIdentityBounds

Length ceilings for the strings that arrive from outside DICE and end up inside stored identity: the canonical source key from SourceLocator.key, a provider-defined source revision, a chunk id, and a content hash.

SourceLocator

sealed interface SourceLocator

A reference to where source material lives.

SourceRevisionRef

data class SourceRevisionRef(val sourceKey: String, val sourceRevision: String)

Identifies an opaque revision of a source.

UriLocator

data class UriLocator constructor(val uri: String, val display: String? = null) : SourceLocator

A locator that points at a resource by URI (e.g. https://..., s3://...).